Skip to content

Improved the documentation for cat indices API #136329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improved the documentation for cat indices API #136329

wants to merge 2 commits into from
+1 −1

Conversation

mridula-s109
Copy link
Contributor

Summary

  • clarify the _cat/indices documentation to state that docs.count is taken directly from Lucene
  • note that this includes hidden nested documents (including those created by semantic_text)
  • point readers to _cat/count and _count when they need the logical/top-level document count instead

Github issue - #127354

@mridula-s109 mridula-s109 requested review from a team and leemthompo October 9, 2025 21:00
@mridula-s109 mridula-s109 self-assigned this Oct 9, 2025
@mridula-s109 mridula-s109 added >docs General docs changes Team:Docs Meta label for docs team :SearchOrg/Relevance Label for the Search (solution/org) Relevance team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch labels Oct 9, 2025
@mridula-s109 mridula-s109 changed the title Improved the documentation for cat indices api Improved the documentation for cat indices API Oct 9, 2025
@mridula-s109 mridula-s109 marked this pull request as ready for review October 9, 2025 21:03
@elasticsearchmachine elasticsearchmachine added Team:Search - Relevance The Search organization Search Relevance team and removed Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch labels Oct 9, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/search-relevance (Team:Search - Relevance)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/core-docs (Team:Docs)

@leemthompo
Copy link
Contributor

Hey @mridula-s109! I think we need to make these changes in the elasticsearch-specification repo.

The file would be https://github.com/elastic/elasticsearch-specification/blob/main/specification/cat/indices/CatIndicesRequest.ts#L25

@leemthompo leemthompo mentioned this pull request Oct 10, 2025
Open
@mridula-s109
Copy link
Contributor Author

Hey @mridula-s109! I think we need to make these changes in the elasticsearch-specification repo.

The file would be https://github.com/elastic/elasticsearch-specification/blob/main/specification/cat/indices/CatIndicesRequest.ts#L25

@leemthompo thanks for the guidance. i will have a look at it and create a new PR.

kderusso
kderusso requested changes Oct 10, 2025
View reviewed changes
Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed on the specification PR requirement, but I feel that instead of this change, we could also add a clarifying note on the API Markdown docs. This definitely isn't the place to document it though.

@leemthompo
Copy link
Contributor

@kderusso you mean adding something on this page too https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text? Yep that sounds right.

@kderusso
Copy link
Member

@kderusso you mean adding something on this page too https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text? Yep that sounds right.

Yep! Thanks @leemthompo - @mridula-s109 would you please update this PR accordingly?

@mridula-s109
Copy link
Contributor Author

@kderusso you mean adding something on this page too https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text? Yep that sounds right.

Yep! Thanks @leemthompo - @mridula-s109 would you please update this PR accordingly?

Yes @kderusso , thanks for the comment. I will update the current PR to update the semantic text doc accordingly and also another new PR for the specification repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kderusso kderusso kderusso requested changes

@leemthompo leemthompo Awaiting requested review from leemthompo

Requested changes must be addressed to merge this pull request.

Assignees

@mridula-s109 mridula-s109

Labels

>docs General docs changes :SearchOrg/Relevance Label for the Search (solution/org) Relevance team Team:Docs Meta label for docs team Team:Search - Relevance The Search organization Search Relevance team v9.3.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mridula-s109 @elasticsearchmachine @leemthompo @kderusso